<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>KeyboardShortcutHandler (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>

  <script type="text/javascript" src="//www.google.com/jsapi"></script>
  <script type="text/javascript">
     google.load("visualization", "1", {packages:["orgchart"]});
     var _loadingVisualizations = true;
  </script>

  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
        <span class="fn">ui.KeyboardShortcutHandler</span>
        <span>Extends</span>
        <span class="fn-name">
          <a href="class_goog_events_EventTarget.html">
          goog.events.EventTarget
</a>
        </span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Component for handling keyboard shortcuts. A shortcut is registered and bound
to a specific identifier. Once the shortcut is triggered an event is fired
with the identifier for the shortcut. This allows keyboard shortcuts to be
customized without modifying the code that listens for them.

Supports keyboard shortcuts triggered by a single key, a stroke stroke (key
plus at least one modifier) and a sequence of keys or strokes.


  </div>


        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="http://closure-library.googlecode.com/git/closure/goog/demos/keyboardshortcuts.html">Demo</a></li>
            <li><a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/local/closure/goog/ui/keyboardshortcuthandler.js">Git</a></li>
          </ol>
        </div>
</div>






<h2 class="g-first">Inheritance</h2>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
  <tr><td><span class="type"><a href="class_goog_Disposable.html">goog.Disposable</a></span></td><td></td></tr>
  <tr><td><span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span></td><td><span class="type"><a href="class_goog_Disposable.html">goog.Disposable</a></span></td></tr>
  <tr><td>goog.ui.KeyboardShortcutHandler</td><td><span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span></td></tr>
</table>
</div>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
</table>
</div>




  <h2>Constructor</h2>
      <div class="fn-constructor">
    goog.ui.KeyboardShortcutHandler(<span><span class="arg">keyTarget</span></span>)
  </div>

   <h3>Parameters</h3>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">keyTarget</span>
        : <span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span><span>&nbsp;|&nbsp;</span><span class="type">EventTarget</span>
        <div class="entryOverview">Event target that the
    key event listener is attached to, typically the applications root
    container.</div>
     </td>
   </tr>
  </table>


<h2>Instance Methods</h2>


  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_ui_KeyboardShortcutHandler.html">
              goog.ui.KeyboardShortcutHandler
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.checkShortcut_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">checkShortcut_<span class="args">(<span class="arg">strokes</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Checks if a particular keyboard shortcut is registered.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">strokes</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>&gt;
        <div class="entryOverview">Strokes array.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            True iff the keyboard is registred.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line836">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry protected">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.clearKeyListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">clearKeyListener<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Removes the listener that was added by link <code> #initializeKeyListener</code>.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line756">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.disposeInternal"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">disposeInternal<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line568">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.getAllShortcutsAreGlobal"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getAllShortcutsAreGlobal<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Returns whether all shortcuts (including modifier shortcuts) are treated as
if the keys had been passed to the setGlobalKeys function.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether all shortcuts are treated as globals.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line355">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.getAlwaysPreventDefault"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getAlwaysPreventDefault<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Returns whether the default action will always be prevented when a shortcut
event is fired. The default value is true.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether preventDefault will always be called.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line306">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.getAlwaysStopPropagation"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getAlwaysStopPropagation<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Returns whether the event will always be stopped from propagating beyond its
target when a shortcut event is fired. The default value is false.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether stopPropagation will always be called.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line332">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.getEventType"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getEventType<span class="args">(<span class="arg">identifier</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
      </div>


     <div class="entryOverview">
       Returns event type for a specific shortcut.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">identifier</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">Identifier for the shortcut task.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&nbsp;
            Theh event type.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line580">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.getGlobalKeys"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getGlobalKeys<span class="args">()</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&gt;
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&gt;&nbsp;
            The global keys, i.e. keys that are safe to always
    regard as shortcuts, even if entered in a textarea or input field.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line562">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.getModifierShortcutsAreGlobal"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getModifierShortcutsAreGlobal<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Returns whether shortcuts with modifiers are treated as if the keys had been
passed to the setGlobalKeys function.  Ignored if you have called
setAllShortcutsAreGlobal(true).  Applies only to form elements (not
content-editable).

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether shortcuts with modifiers are treated as globals.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line383">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.getShortcut_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getShortcut_<span class="args">(<span class="arg">strokes</span>,&nbsp;<span class="arg">opt_index</span>,&nbsp;<span class="arg">opt_list</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
      </div>


     <div class="entryOverview">
       Returns shortcut for a specific set of strokes.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">strokes</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&gt;
        <div class="entryOverview">Strokes array.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_index</span>
        : <span class="type">number=</span>
        <div class="entryOverview">Index in array to start with.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_list</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">List to search for shortcut in.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>&nbsp;
            The shortcut.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line814">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.handleGeckoKeyUp_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">handleGeckoKeyUp_<span class="args">(<span class="arg">e</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Handler for when a keyup event is fired in Firefox (Gecko).

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">e</span>
        : <span class="type"><a href="class_goog_events_BrowserEvent.html">goog.events.BrowserEvent</a></span>
        <div class="entryOverview">The key event.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line667">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.handleKeyDown_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">handleKeyDown_<span class="args">(<span class="arg">event</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Keypress handler.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">event</span>
        : <span class="type"><a href="class_goog_events_BrowserEvent.html">goog.events.BrowserEvent</a></span>
        <div class="entryOverview">Keypress event.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line874">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.handleWindowsKeyPress_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">handleWindowsKeyPress_<span class="args">(<span class="arg">e</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Handler for when a keypress event is fired on Windows.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">e</span>
        : <span class="type"><a href="class_goog_events_BrowserEvent.html">goog.events.BrowserEvent</a></span>
        <div class="entryOverview">The key event.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line727">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.handleWindowsKeyUp_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">handleWindowsKeyUp_<span class="args">(<span class="arg">e</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Handler for when a keyup event is fired on Windows.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">e</span>
        : <span class="type"><a href="class_goog_events_BrowserEvent.html">goog.events.BrowserEvent</a></span>
        <div class="entryOverview">The key event.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line743">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry protected">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.initializeKeyListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">initializeKeyListener<span class="args">(<span class="arg">keyTarget</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Adds a key event listener that triggers <code> #handleKeyDown_</code> when keys
are pressed.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">keyTarget</span>
        : <span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span><span>&nbsp;|&nbsp;</span><span class="type">EventTarget</span>
        <div class="entryOverview">Event target that the
    event listener should be attached to.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line635">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.interpretStrokes_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">interpretStrokes_<span class="args">(<span class="arg">initialIndex</span>,&nbsp;<span class="arg">args</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>&gt;
      </div>


     <div class="entryOverview">
       Parses the variable arguments for registerShortcut and unregisterShortcut.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">initialIndex</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
        <div class="entryOverview">The first index of "args" to treat as
    variable arguments.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">args</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">The "arguments" array passed
    to registerShortcut or unregisterShortcut.  Please see the comments in
    registerShortcut for list of allowed forms.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>&gt;&nbsp;
            The sequence of objects containing the
    keyCode and modifiers of each key in sequence.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line510">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.isPossiblePrintableKey_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isPossiblePrintableKey_<span class="args">(<span class="arg">e</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Returns whether this event is possibly used for typing a printable character.
Windows uses ctrl+alt (a.k.a. alt-graph) keys for typing characters on
European keyboards. Since only Firefox provides a method that can identify
whether ctrl+alt keys are used for typing characters, we need to check
whether Windows sends a keypress event to prevent firing shortcut event if
this event is used for typing characters.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">e</span>
        : <span class="type"><a href="class_goog_events_BrowserEvent.html">goog.events.BrowserEvent</a></span>
        <div class="entryOverview">The key event.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether this event is a possible printable-key event.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line715">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.isShortcutRegistered"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isShortcutRegistered<span class="args">(<span class="arg">var_args</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Verifies if a particular keyboard shortcut is registered already. It has
the same interface as the unregistering of shortcuts.

param {number} keyCode Numeric code for key
param {number=} opt_modifiers Bitmap indicating required modifier keys.
                goog.ui.KeyboardShortcutHandler.Modifiers.SHIFT, CONTROL,
                ALT, or META.

The two parameters can be repeated any number of times to create a shortcut
using a sequence of strokes.

A string representation of the shortcut can be supplied instead see
<code> #registerShortcut</code> for syntax. In that case the method only takes one
argument.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">var_args</span>
        : <span class="type">...(number</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&gt;)
        <div class="entryOverview">String representation, or
    array or list of alternating key codes and modifiers.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether the specified keyboard shortcut is registered.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line493">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.isValidShortcut_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isValidShortcut_<span class="args">(<span class="arg">event</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Checks if a given keypress event may be treated as a shortcut.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">event</span>
        : <span class="type"><a href="class_goog_events_BrowserEvent.html">goog.events.BrowserEvent</a></span>
        <div class="entryOverview">Keypress event.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether to attempt to process the event as a shortcut.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line985">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.registerShortcut"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">registerShortcut<span class="args">(<span class="arg">identifier</span>,&nbsp;<span class="arg">var_args</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Registers a keyboard shortcut.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">identifier</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">Identifier for the task performed by the keyboard
                combination. Multiple shortcuts can be provided for the same
                task by specifying the same identifier.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">var_args</span>
        : <span class="type">...(number</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&gt;)
        <div class="entryOverview">See below.

param {number} keyCode Numeric code for key
param {number=} opt_modifiers Bitmap indicating required modifier keys.
               goog.ui.KeyboardShortcutHandler.Modifiers.SHIFT, CONTROL,
               ALT, or META.

The last two parameters can be repeated any number of times to create a
shortcut using a sequence of strokes. Instead of varagrs the second parameter
could also be an array where each element would be ragarded as a parameter.

A string representation of the shortcut can be supplied instead of the last
two parameters. In that case the method only takes two arguments, the
identifier and the string.

Examples:
  g               registerShortcut(str, G_KEYCODE)
  Ctrl+g          registerShortcut(str, G_KEYCODE, CTRL)
  Ctrl+Shift+g    registerShortcut(str, G_KEYCODE, CTRL | SHIFT)
  Ctrl+g a        registerShortcut(str, G_KEYCODE, CTRL, A_KEYCODE)
  Ctrl+g Shift+a  registerShortcut(str, G_KEYCODE, CTRL, A_KEYCODE, SHIFT)
  g a             registerShortcut(str, G_KEYCODE, NONE, A_KEYCODE)

Examples using string representation for shortcuts:
  g               registerShortcut(str, 'g')
  Ctrl+g          registerShortcut(str, 'ctrl+g')
  Ctrl+Shift+g    registerShortcut(str, 'ctrl+shift+g')
  Ctrl+g a        registerShortcut(str, 'ctrl+g a')
  Ctrl+g Shift+a  registerShortcut(str, 'ctrl+g shift+a')
  g a             registerShortcut(str, 'g a').</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line437">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.setAllShortcutsAreGlobal"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setAllShortcutsAreGlobal<span class="args">(<span class="arg">allShortcutsGlobal</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets whether to treat all shortcuts (including modifier shortcuts) as if the
keys had been passed to the setGlobalKeys function.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">allShortcutsGlobal</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Whether to treat all shortcuts as global.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line343">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.setAllowSpaceKeyOnButtons"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setAllowSpaceKeyOnButtons<span class="args">(<span class="arg">allowSpaceKeyOnButtons</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets whether to treat space key as a shortcut when the focused element is a
checkbox, radiobutton or button.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">allowSpaceKeyOnButtons</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Whether to treat space key as a
    shortcut when the focused element is a checkbox, radiobutton or button.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line395">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.setAlwaysPreventDefault"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setAlwaysPreventDefault<span class="args">(<span class="arg">alwaysPreventDefault</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets whether to always prevent the default action when a shortcut event is
fired. If false, the default action is prevented only if preventDefault is
called on either of the corresponding SHORTCUT_TRIGGERED or SHORTCUT_PREFIX
events. If true, the default action is prevented whenever a shortcut event
is fired. The default value is true.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">alwaysPreventDefault</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Whether to always call preventDefault.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line294">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.setAlwaysStopPropagation"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setAlwaysStopPropagation<span class="args">(<span class="arg">alwaysStopPropagation</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets whether to always stop propagation for the event when fired. If false,
the propagation is stopped only if stopPropagation is called on either of the
corresponding SHORT_CUT_TRIGGERED or SHORTCUT_PREFIX events. If true, the
event is prevented from propagating beyond its target whenever it is fired.
The default value is false.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">alwaysStopPropagation</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Whether to always call
    stopPropagation.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line320">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.setGlobalKeys"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setGlobalKeys<span class="args">(<span class="arg">keys</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets the global keys; keys that are safe to always regarded as shortcuts,
even if entered in a textarea or input field.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">keys</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&gt;
        <div class="entryOverview">List of keys.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line553">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.setModifierShortcutsAreGlobal"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setModifierShortcutsAreGlobal<span class="args">(<span class="arg">modifierShortcutsGlobal</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets whether to treat shortcuts with modifiers as if the keys had been
passed to the setGlobalKeys function.  Ignored if you have called
setAllShortcutsAreGlobal(true).  Applies only to form elements (not
content-editable).

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">modifierShortcutsGlobal</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Whether to treat shortcuts with
    modifiers as global.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line369">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.unregisterAll"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">unregisterAll<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Unregisters all keyboard shortcuts.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line543">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.prototype.unregisterShortcut"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">unregisterShortcut<span class="args">(<span class="arg">var_args</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Unregisters a keyboard shortcut by keyCode and modifiers or string
representation of sequence.

param {number} keyCode Numeric code for key
param {number=} opt_modifiers Bitmap indicating required modifier keys.
                goog.ui.KeyboardShortcutHandler.Modifiers.SHIFT, CONTROL,
                ALT, or META.

The two parameters can be repeated any number of times to create a shortcut
using a sequence of strokes.

A string representation of the shortcut can be supplied instead see
<code> #registerShortcut</code> for syntax. In that case the method only takes one
argument.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">var_args</span>
        : <span class="type">...(number</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&gt;)
        <div class="entryOverview">String representation, or
    array or list of alternating key codes and modifiers.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line465">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_events_EventTarget.html">
              goog.events.EventTarget
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td class="deprecated">
    <a name="goog.events.EventTarget.prototype.addEventListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">addEventListener<span class="args">(<span class="arg">type</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capture</span>,&nbsp;<span class="arg">opt_handlerScope</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class="deprecatedMessage">Use <code> #listen</code> instead, when possible. Otherwise, use
    <code> goog.events.listen</code> if you are passing Object
    (instead of Function) as handler.</span>
       Adds an event listener to the event target. The same handler can only be
added once per the type. Even if you add the same handler multiple times
using the same type then it will only be called once when the event is
dispatched.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">The type of the event to listen for.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName"></span>
        : <span>?</span><span class="type">function(</span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_capture</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">In DOM-compliant browsers, this determines
    whether the listener is fired during the capture or bubble phase
    of the event.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_handlerScope</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">Object in whose scope to call
    the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line153">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.assertInitialized_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">assertInitialized_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Asserts that the event target instance is initialized properly.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line332">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.dispatchEvent"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">dispatchEvent<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line184">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.disposeInternal"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">disposeInternal<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Removes listeners from this object.  Classes that extend EventTarget may
need to override this method in order to remove references to DOM Elements
and additional listeners.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line210">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.fireListeners"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">fireListeners<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line264">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.getListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getListener<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line302">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.getListeners"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getListeners<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line296">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.getParentEventTarget"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getParentEventTarget<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span>
      </div>


     <div class="entryOverview">
       Returns the parent of this event target to use for bubbling.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span>&nbsp;
            The parent EventTarget or null if
    there is no parent.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line119">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.hasListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">hasListener<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line310">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.listen"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">listen<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line219">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.listenOnce"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">listenOnce<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line229">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.removeAllListeners"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">removeAllListeners<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line252">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td class="deprecated">
    <a name="goog.events.EventTarget.prototype.removeEventListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">removeEventListener<span class="args">(<span class="arg">type</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capture</span>,&nbsp;<span class="arg">opt_handlerScope</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class="deprecatedMessage">Use <code> #unlisten</code> instead, when possible. Otherwise, use
    <code> goog.events.unlisten</code> if you are passing Object
    (instead of Function) as handler.</span>
       Removes an event listener from the event target. The handler must be the
same object as the one added. If the handler has not been added then
nothing is done.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">The type of the event to listen for.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName"></span>
        : <span>?</span><span class="type">function(</span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_capture</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">In DOM-compliant browsers, this determines
    whether the listener is fired during the capture or bubble phase
    of the event.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_handlerScope</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">Object in whose scope to call
    the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line177">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.setParentEventTarget"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setParentEventTarget<span class="args">(<span class="arg">parent</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets the parent of this event target to use for capture/bubble
mechanism.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">parent</span>
        : <span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span>
        <div class="entryOverview">Parent listenable (null if none).</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line129">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.setTargetForTesting"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setTargetForTesting<span class="args">(<span class="arg">target</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets the target to be used for <code> event.target</code> when firing
event. Mainly used for testing. For example, see
<code> goog.testing.events.mixinListenable</code>.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">target</span>
        : <span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">The target.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line323">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.unlisten"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">unlisten<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line238">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.EventTarget.prototype.unlistenByKey"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">unlistenByKey<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line246">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_Disposable.html">
              goog.Disposable
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.Disposable.prototype.addOnDisposeCallback"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">addOnDisposeCallback<span class="args">(<span class="arg">callback</span>,&nbsp;<span class="arg">opt_scope</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Invokes a callback function when this object is disposed. Callbacks are
invoked in the order in which they were added.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">callback</span>
        : <span class="type">function(this:T</span>)<span>:?</span>
        <div class="entryOverview">The callback function.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_scope</span>
        : <span class="type">T=</span>
        <div class="entryOverview">An optional scope to call the callback in.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line211">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.Disposable.prototype.dispose"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">dispose<span class="args">()</span>
        </span>
        &#8658; <span class="type">void</span>
      </div>


     <div class="entryOverview">
       Disposes of the object. If the object hasn't already been disposed of, calls
<code> #disposeInternal</code>. Classes that extend <code> goog.Disposable</code> should
override <code> #disposeInternal</code> in order to delete references to COM
objects, DOM nodes, and other disposable objects. Reentrant.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type">void</span>&nbsp;
            Nothing.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line172">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry protected">
       <td class="access"></td>






  <td>
    <a name="goog.Disposable.prototype.disposeInternal"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">disposeInternal<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Deletes or nulls out any references to COM objects, DOM nodes, or other
disposable objects. Classes that extend <code> goog.Disposable</code> should
override this method.
Not reentrant. To avoid calling it twice, it must only be called from the
subclass' <code> disposeInternal</code> method. Everywhere else the public
<code> dispose</code> method must be used.
For example:
<pre class="lang-js prettyprint">
  mypackage.MyClass = function() {
    goog.base(this);
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    goog.base(this, 'disposeInternal');
  };
</pre>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line245">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td class="deprecated">
    <a name="goog.Disposable.prototype.getDisposed"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getDisposed<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       <span class="deprecatedMessage">Use <code> #isDisposed</code> instead.</span>
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether the object has been disposed of.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line160">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.Disposable.prototype.isDisposed"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isDisposed<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether the object has been disposed of.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line151">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.Disposable.prototype.registerDisposable"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">registerDisposable<span class="args">(<span class="arg">disposable</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Associates a disposable object with this object so that they will be disposed
together.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">disposable</span>
        : <span class="type"><a href="interface_goog_disposable_IDisposable.html">goog.disposable.IDisposable</a></span>
        <div class="entryOverview">that will be disposed when
    this object is disposed.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line199">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Instance Properties</h2>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_ui_KeyboardShortcutHandler.html">
              goog.ui.KeyboardShortcutHandler
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.activeShortcutKeyForGecko_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">activeShortcutKeyForGecko_</span>
        : 
     </div>


     <div class="entryOverview">
       Tracks the currently pressed shortcut key, for Firefox.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line138">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.allShortcutsAreGlobal_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">allShortcutsAreGlobal_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether to treat all shortcuts as if they had been passed
to setGlobalKeys().

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line114">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.allowSpaceKeyOnButtons_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">allowSpaceKeyOnButtons_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether to treat space key as a shortcut when the focused element is a
checkbox, radiobutton or button.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line131">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.alwaysPreventDefault_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">alwaysPreventDefault_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether to always prevent the default action if a shortcut event is fired.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line99">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.alwaysStopPropagation_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">alwaysStopPropagation_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether to always stop propagation if a shortcut event is fired.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line106">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.constructor"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">constructor</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line53">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.globalKeys_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">globalKeys_</span>
        : 
     </div>


     <div class="entryOverview">
       List of numeric key codes for keys that are safe to always regarded as
shortcuts, even if entered in a textarea or input field.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line83">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.isPrintableKey_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">isPrintableKey_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether a key event is a printable-key event. Windows uses ctrl+alt
(alt-graph) keys to type characters on European keyboards. For such keys, we
cannot identify whether these keys are used for typing characters when
receiving keydown events. Therefore, we set this flag when we receive their
respective keypress events and fire shortcut events only when we do not
receive them.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line263">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.keyTarget_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">keyTarget_</span>
        : <span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span>
     </div>


     <div class="entryOverview">
       Target on which to listen for key events.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line236">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.lastKeys_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">lastKeys_</span>
        : 
     </div>


     <div class="entryOverview">
       List of the last sequence of strokes. Object contains time last key was
pressed and an array of strokes, represented by numeric value.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line72">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.metaKeyRecentlyReleased_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">metaKeyRecentlyReleased_</span>
        : 
     </div>


     <div class="entryOverview">
       Due to a bug in the way that Gecko on Mac handles cut/copy/paste key events
using the meta key, it is necessary to fake the keyDown for the action key
(C,V,X) by capturing it on keyUp.
Because users will often release the meta key a slight moment before they
release the action key, we need this variable that will store whether the
meta key has been released recently.
It will be cleared after a short delay in the key handling logic.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line250">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.modifierShortcutsAreGlobal_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">modifierShortcutsAreGlobal_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether to treat shortcuts with modifiers as if they had been passed
to setGlobalKeys().  Ignored if allShortcutsAreGlobal_ is true.  Applies
only to form elements (not content-editable).

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line123">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.shortcuts_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">shortcuts_</span>
        : 
     </div>


     <div class="entryOverview">
       Registered keyboard shortcuts tree. Stored as a map with the keyCode and
modifier(s) as the key and either a list of further strokes or the shortcut
task identifier as the value.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line64">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.prototype.textInputs_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">textInputs_</span>
        : 
     </div>


     <div class="entryOverview">
       List of input types that should only accept ENTER as a shortcut.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line91">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_events_EventTarget.html">
              goog.events.EventTarget
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.events.EventTarget.prototype.actualEventTarget_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">actualEventTarget_</span>
        : <span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span>
     </div>


     <div class="entryOverview">
       The object to use for event.target. Useful when mixing in an
EventTarget to another object.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line84">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.events.EventTarget.prototype.constructor"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">constructor</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line70">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.events.EventTarget.prototype.eventTargetListeners_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">eventTargetListeners_</span>
        : <span class="type"><a href="class_goog_events_ListenerMap.html">goog.events.ListenerMap</a></span>
     </div>


     <div class="entryOverview">
       Maps of event type to an array of listeners.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line77">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.events.EventTarget.prototype.parentEventTarget_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">parentEventTarget_</span>
        : <span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span>
     </div>


     <div class="entryOverview">
       Parent event target, used during event bubbling.

TODO(user): Change this to goog.events.Listenable. This
currently breaks people who expect getParentEventTarget to return
goog.events.EventTarget.


     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_eventtarget.js.source.html#line109">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_Disposable.html">
              goog.Disposable
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.Disposable.prototype.creationStack"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">creationStack</span>
        : 
     </div>


     <div class="entryOverview">
       If monitoring the goog.Disposable instances is enabled, stores the creation
stack trace of the Disposable instance.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line144">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.Disposable.prototype.disposed_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">disposed_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether the object has been disposed of.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line128">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.Disposable.prototype.onDisposeCallbacks_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">onDisposeCallbacks_</span>
        : 
     </div>


     <div class="entryOverview">
       Callbacks to invoke when this object is disposed.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_disposable_disposable.js.source.html#line136">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Static Methods</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.getKeyCode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">getKeyCode<span class="args">(<span class="arg">name</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
      </div>


     <div class="entryOverview">
       Static method for getting the key code for a given key.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">name</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">Name of key.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&nbsp;
            The key code.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line271">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.makeKey_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">makeKey_<span class="args">(<span class="arg">keyCode</span>,&nbsp;<span class="arg">modifiers</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
      </div>


     <div class="entryOverview">
       Constructs key from key code and modifiers.

The lower 8 bits are used for the key code, the following 3 for modifiers and
the remaining bits are unused.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">keyCode</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
        <div class="entryOverview">Numeric key code.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">modifiers</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
        <div class="entryOverview">Required modifiers.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&nbsp;
            The key.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line862">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.parseStringShortcut"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">parseStringShortcut<span class="args">(<span class="arg">s</span>)</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>&gt;
      </div>


     <div class="entryOverview">
       Builds stroke array from string representation of shortcut.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">s</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">String representation of shortcut.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>&gt;&nbsp;
            The stroke array.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line592">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.ui.KeyboardShortcutHandler.setShortcut_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">setShortcut_<span class="args">(<span class="arg">parent</span>,&nbsp;<span class="arg">strokes</span>,&nbsp;<span class="arg">identifier</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Adds or removes a stroke node to/from the given parent node.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">parent</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">Parent node to add/remove stroke to/from.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">strokes</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>&gt;
        <div class="entryOverview">Array of strokes for shortcut.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">identifier</span>
        : <span>?</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">Identifier for the task performed by shortcut or
    null to clear.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line781">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



<h2>Static Properties</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.DEFAULT_GLOBAL_KEYS_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">DEFAULT_GLOBAL_KEYS_</span>
        : 
     </div>


     <div class="entryOverview">
       Keys marked as global by default.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line171">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.DEFAULT_TEXT_INPUTS_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">DEFAULT_TEXT_INPUTS_</span>
        : 
     </div>


     <div class="entryOverview">
       Text input types to allow only ENTER shortcuts.
Web Forms 2.0 for HTML5: Section 4.10.7 from 29 May 2012.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line195">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.MAX_KEY_SEQUENCE_DELAY"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">MAX_KEY_SEQUENCE_DELAY</span>
        : 
     </div>


     <div class="entryOverview">
       Maximum allowed delay, in milliseconds, allowed between the first and second
key in a key sequence.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line150">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.nameToKeyCodeCache_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">nameToKeyCodeCache_</span>
        : 
     </div>


     <div class="entryOverview">
       Cache for name to key code lookup.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line228">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.superClass_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">superClass_</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line53">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



<h2>Enumerations</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.EventType"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">EventType</span>
        : 
     </div>


     <div class="entryOverview">
       Events.

     </div>

     <div class="entryDetails">
       <div class="detailsSection">
          <b>Constants:</b>
          <table class="horiz-rule">
            <tbody>
              <tr><td>
                <span class="entryName">
                  SHORTCUT_PREFIX
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  SHORTCUT_TRIGGERED
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
           </tbody>
         </table>
       </div>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line217">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.ui.KeyboardShortcutHandler.Modifiers"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.ui.KeyboardShortcutHandler.</span><span class="entryName">Modifiers</span>
        : 
     </div>


     <div class="entryOverview">
       Bit values for modifier keys.

     </div>

     <div class="entryDetails">
       <div class="detailsSection">
          <b>Constants:</b>
          <table class="horiz-rule">
            <tbody>
              <tr><td>
                <span class="entryName">
                  ALT
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  CTRL
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  META
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  NONE
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  SHIFT
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
           </tbody>
         </table>
       </div>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_ui_keyboardshortcuthandler.js.source.html#line157">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package ui</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="" current="ui.KeyboardShortcutHandler"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
